/*
 * Copyright 2010-2020 Alfresco Software, Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.activiti.engine.runtime;

import java.util.Date;
import java.util.Map;

import org.activiti.engine.api.internal.Internal;
import org.activiti.engine.repository.ProcessDefinition;

/**
 * Represents one execution of a {@link ProcessDefinition}.
 *
 */
@Internal
public interface ProcessInstance extends Execution {

	/**
	 * The id of the process definition of the process instance.
	 */
	String getProcessDefinitionId();

	/**
	 * The name of the process definition of the process instance.
	 */
	String getProcessDefinitionName();

	/**
	 * The key of the process definition of the process instance.
	 */
	String getProcessDefinitionKey();

	/**
	 * The version of the process definition of the process instance.
	 */
	Integer getProcessDefinitionVersion();

	/**
	 * The deployment id of the process definition of the process instance.
	 */
	String getDeploymentId();

	/**
	 * The business key of this process instance.
	 */
	String getBusinessKey();

	/**
	 * returns true if the process instance is suspended
	 */
	boolean isSuspended();

	/**
	 * Returns the process variables if requested in the process instance query
	 */
	Map<String, Object> getProcessVariables();

	/**
	 * The tenant identifier of this process instance
	 */
	String getTenantId();

	/**
	 * Returns the name of this process instance.
	 */
	String getName();

	/**
	 * Returns the description of this process instance.
	 */
	String getDescription();

	/**
	 * Returns the localized name of this process instance.
	 */
	String getLocalizedName();

	/**
	 * Returns the localized description of this process instance.
	 */
	String getLocalizedDescription();

	/**
	 * Returns the start time of this process instance.
	 */
	Date getStartTime();

	/**
	 * Returns the user id of this process instance.
	 */
	String getStartUserId();

	void setAppVersion(Integer appVersion);

	Integer getAppVersion();
}
